package com.zdpx.pxframework.system.api;

import com.zdpx.pxframework.core.vo.PageResult;
import com.zdpx.pxframework.core.vo.Result;
import com.zdpx.pxframework.system.entity.RoleMenu;
import com.zdpx.pxframework.system.vo.query.RoleMenuQuery;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

import java.util.List;


/**
 * 角色菜单关联 接口Swagger Api
 *
 * @Description:
 * @Author: Cheng XiaoXiao
 * @Date: 2022-02-27 15:20:14
 */
@Api(tags = "角色菜单关联模块", description = "实现对角色菜单关联数据的基本操作")
public interface RoleMenuControllerApi {


    /**
     * 按照条件查询角色菜单关联信息
     *
     * @param roleMenuQuery 查询条件
     * @return 结果信息
     */
    @ApiOperation(value = "按照条件查询角色菜单关联信息")
    Result<List<RoleMenu>> list(RoleMenuQuery roleMenuQuery);

    /**
     * 分页及条件查询角色菜单关联信息
     *
     * @param page          页码
     * @param size          分页大小
     * @param roleMenuQuery 查询条件
     * @return 分页结果信息
     */
    @ApiOperation(value = "分页及条件查询角色菜单关联信息")
    Result<PageResult<RoleMenu>> search(@ApiParam(name = "page", value = "当前页", required = true, type = "path") Long page,
                                        @ApiParam(name = "size", value = "页码大小", required = true, type = "path") Long size,
                                        RoleMenuQuery roleMenuQuery);

    /**
     * 根据ID获取角色菜单关联详情
     *
     * @param id 角色菜单关联ID
     * @return 角色菜单关联详细信息
     */
    @ApiOperation(value = "获取单个角色菜单关联详情")
    @ApiParam(name = "id", value = "角色菜单关联ID", required = true, type = "path")
    Result<RoleMenu> detail(String id);

    /**
     * 增加角色菜单关联信息
     *
     * @param roleMenu 角色菜单关联增加实体
     * @return 增加后的角色菜单关联信息
     */
    @ApiOperation(value = "增加角色菜单关联信息")
    Result<RoleMenu> add(RoleMenu roleMenu);

    /**
     * 修改角色菜单关联信息
     *
     * @param id       角色菜单关联ID
     * @param roleMenu 角色菜单关联修改实体
     * @return 修改后的角色菜单关联信息
     */
    @ApiOperation(value = "修改角色菜单关联信息")
    Result<RoleMenu> updateById(@ApiParam(name = "id", value = "角色菜单关联ID", type = "path") String id, RoleMenu roleMenu);

    /**
     * 删除角色菜单关联信息
     *
     * @param id 角色菜单关联ID
     * @return 删除结果信息
     */
    @ApiOperation(value = "删除单个角色菜单关联信息")
    Result<Boolean> deleteById(@ApiParam(name = "id", value = "角色菜单关联ID", type = "path") String id);

    /**
     * 删除角色菜单关联信息
     *
     * @param idList 角色菜单关联ID数组
     * @return 删除结果信息
     */
    @ApiOperation(value = "批量删除角色菜单关联信息")
    Result<Boolean> batchRemove(List<String> idList);

}
